docs: improve documentation and error messages for ContainerizationEx…#147
Closed
KushagraSikka wants to merge 2 commits intoapple:mainfrom
Closed
docs: improve documentation and error messages for ContainerizationEx…#147KushagraSikka wants to merge 2 commits intoapple:mainfrom
KushagraSikka wants to merge 2 commits intoapple:mainfrom
Conversation
…tras - Enhanced IPv4Address documentation with comprehensive examples and parameter descriptions - Improved error messages in NetworkAddressError with actionable guidance - Added detailed documentation for CIDRAddress including usage examples and method descriptions - Expanded AsyncLock documentation with use cases and threading safety information - Enhanced Timeout documentation with implementation details and performance notes - Improved error message clarity in Timeout.swift by replacing generic fatalError These changes make the API more accessible to new contributors and provide better developer experience through clear error messages and comprehensive documentation.
Member
|
Are these mostly copies of what's already in #148? |
Author
|
Hi @dcantah — great catch and thanks for reviewing! You’re absolutely right: this PR (#147) contains the same documentation changes already included in #148. The key difference is that #148 also adds: I initially opened this PR to separate the doc/error message improvements, but ultimately included them in #148 as well to keep the test coverage self-contained and traceable to the updated APIs. Feel free to close this one in favor of #148 if you prefer a single merge path — happy to streamline however you see fit! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Enhanced IPv4Address documentation with comprehensive examples and parameter descriptions - Improved error messages in NetworkAddressError with actionable guidance - Added detailed documentation for CIDRAddress including usage examples and method descriptions - Expanded AsyncLock documentation with use cases and threading safety information - Enhanced Timeout documentation with implementation details and performance notes - Improved error message clarity in Timeout.swift by replacing generic fatalError These changes make the API more accessible to new contributors and provide better developer experience through clear error messages and comprehensive documentation.